docs: add index README and YAML frontmatter to every doc#14
Merged
Conversation
Convert §6.2 of language-cli-survey.md into an actionable punch list for the remaining Phase 3 work — m fix, m profile, m bench, and m debug — with explicit dependencies, priority ordering, exit criteria, and per-subcommand risks. Phase 3a is shipped, so the plan picks up at 3b. Add a pointer from language-cli-survey.md so the plan is discoverable from the source survey. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This reverts c27dbfa. The doc was scoped to m-cli's internal Phase 3 from language-cli-survey.md §6.2 (m fix / m profile / m bench / m debug), but "Phase 3" in this org refers to the org-level AI-discoverability Phase 3 (recipes + handshake test) tracked in .github/docs/. The plan now lands there instead. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Add docs/README.md indexing every document in docs/ with a shared TYPE/CONNECTION vocabulary used consistently across all m-dev-tools repos. Add YAML frontmatter (created, last_modified, revisions, doc_type) to every existing doc. Existing frontmatter is merged, not replaced. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
rafael5
added a commit
that referenced
this pull request
May 11, 2026
Closes followup #14 (runtime YDB-version drift) and stages 4b.1+4b.2 of the m-engine plan. Coordinated with m-test-engine commit 1e7a4cc (Phase 4a: docker/mte introspection script). * engine_driver.py - `DockerDriver.mte_status()` — shells out to `docker exec <container> mte status --json`; returns parsed dict or None (graceful on non-zero rc, garbage output, container down). - `EngineStatus.mte: dict | None` (default None). `to_dict()` serialises it. - `DockerDriver.status(*, verbose=False)` — verbose=True populates `mte` and adds `runtime_ydb_version_drift` to mismatches when `mte["release"]` != `manifest.ydb_version`. De-duped against the static-label `ydb_version_drift` from Phase 3b. - Protocol grew `mte_status()` and the `verbose` kwarg on `status()`. * engine_cli.py - `m engine status --verbose / -v` flag wired; text output gains an "inside container (mte):" block with release/uptime/globals/ routines/mounted_repos. `--json` output gets the mte block via EngineStatus.to_dict(). - `m engine watch` (new) — long-running poll of `mte_status()`; emits one JSON-lines record per poll with `ts` wall-clock timestamp. `--interval` (default 5s, min 0.1) controls cadence; `--count N` caps the loop (`0` = until SIGINT). KeyboardInterrupt → clean exit rc 0. - `m engine capabilities` payload advertises `watch` as read_only:true. * tests/test_engine_driver.py — 8 new tests for mte_status() (parse / None on bad rc / None on garbage), status verbose folding, drift detection, non-verbose skip, container-down skip. * tests/test_engine_cli.py — 5 new tests for --verbose pass-through, text/JSON rendering, watch JSON-lines + error-line behaviour. * tests/test_doctor.py — single drive-by fix to `test_doctor_cli_exits_one_when_any_fail`: monkeypatch `docker_available` → False so the existing demote-when-engine-OK path (a separate prior addition implementing followup #6) doesn't override the test's expected `ydb_dist=FAIL` on hosts where docker is healthy. Preserves the test's original intent without depending on the local environment. Full suite 1471 passing / 1 skipped (was 1453); ruff + mypy clean. Live `m engine status --verbose` on this host correctly detected `runtime_ydb_version_drift` because the running image is V7.1-002 (yottadb-base:latest-master tip) while the manifest declares `ydb_version: "r2.02"`. `m engine watch --interval 0.2 --count 2` emitted 2 valid JSON-lines records. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/README.mdindexing every document indocs/with the shared TYPE/CONNECTION vocabulary established across the m-dev-tools org on 2026-05-11.created,last_modified,revisions,doc_type) to every existing doc indocs/. Existing frontmatter is merged, not replaced.m-dev-tools/.githubatdocs/docs-discoverability/README.md(committed via #35).Test plan
make check-docs-prosegate passes (docs/ is still prose-only).docs/README.mdlists every doc; labels use the agreed 23-type vocabulary.module:/synopsis:/errors:/conformance:/ etc. fields).🤖 Generated with Claude Code